<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.app.radiance.Radiance</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.app-module.html">Package&nbsp;app</a> ::
        <a href="py2ecotect.app.radiance-module.html">Module&nbsp;radiance</a> ::
        Class&nbsp;Radiance
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.app.radiance.Radiance-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Radiance</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Radiance</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#load" class="summary-sig-name">load</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Loads the radiance point data file into ECOTECT.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#load_grid" class="summary-sig-name">load_grid</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Loads the radiance point data file into ECOTECT, as grid data.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load_grid">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#load_object" class="summary-sig-name">load_object</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Loads the radiance point data file into ECOTECT, as object data.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#render" class="summary-sig-name">render</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>)</span><br />
      Begins the radiance rendering process.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.render">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#get_flag" class="summary-sig-name">get_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>)</span><br />
      Retrieves the current setting for the specified flag.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.get_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#set_flag" class="summary-sig-name">set_flag</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">flag</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets or resets the specified radiance option flag(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.set_flag">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#get_resolution" class="summary-sig-name">get_resolution</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the current setting specifying the resolution of the 
      resulting image.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.get_resolution">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.radiance.Radiance-class.html#set_resolution" class="summary-sig-name">set_resolution</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">xres</span>,
        <span class="summary-sig-arg">yres</span>)</span><br />
      Sets the resolution for the resulting image.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.set_resolution">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#action" class="summary-name">action</a><br />
      Retrieves the current set radiance render action setting.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#detail" class="summary-name">detail</a><br />
      Retrieves the current level of geometric complexity within the model.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#image_type" class="summary-name">image_type</a><br />
      Retrieves the currently set image type.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#lights" class="summary-name">lights</a><br />
      Retrieves the current setting for how LIGHT objects are exported in 
      Radiance scene files.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#point_data" class="summary-name">point_data</a><br />
      Retrieves the current setting for what, if any, point data is 
      exported for analysis in Radiance.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#quality" class="summary-name">quality</a><br />
      Retrieves the current setting for the amount of anti-aliasing in the 
      final render.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#reflections" class="summary-name">reflections</a><br />
      Retrieves the current setting for the number of surface reflections 
      that are traced from each sampling point ray.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#scale" class="summary-name">scale</a><br />
      Retrieves the current setting of the scaling value from world 
      coordinates to Radiance coordinantes.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#sky" class="summary-name">sky</a><br />
      Retrieves the current setting of how the sky is exported in the 
      sky.rad file.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#variability" class="summary-name">variability</a><br />
      Retrieves the setting of the likely difference in light levels 
      between adjacent points on a surface.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.app.radiance.Radiance-class.html#view_type" class="summary-name">view_type</a><br />
      Retrieves the currently set internal/external view type.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="load"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the radiance point data file into ECOTECT.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[filename] This optional filename parameter must point to a file 
  containing point or object data calculated using the Generate Point Data 
  Option in the Radiance Export dialog. It must also directly correspond to
  either the current analysis grid or the attributes of objects in the 
  model. If the filename parameter is not given, ECOTECT uses the last 
  output file used by its Radiance calculation functions.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load_grid"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load_grid</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load_grid">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the radiance point data file into ECOTECT, as grid data.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[filename] This optional filename parameter must point to a file 
  containing point or object data calculated using the Generate Point Data 
  Option in the Radiance Export dialog. It must also directly correspond to
  either the current analysis grid or the attributes of objects in the 
  model. If the filename parameter is not given, ECOTECT uses the last 
  output file used by its Radiance calculation functions.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="load_object"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">load_object</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.load_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Loads the radiance point data file into ECOTECT, as object data.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>[filename] This optional filename parameter must point to a file 
  containing point or object data calculated using the Generate Point Data 
  Option in the Radiance Export dialog. It must also directly correspond to
  either the current analysis grid or the attributes of objects in the 
  model. If the filename parameter is not given, ECOTECT uses the last 
  output file used by its Radiance calculation functions.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="render"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">render</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.render">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Begins the radiance rendering process.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>filename The full directory path of where the rendering output will be
  stored.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.get_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current setting for the specified flag.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value specifying the flag, information of which to 
  retrieve, according to the following Radiance Flag Codes table.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state Whether or not the specified flag is set. This is a boolean 
  value where 1 means it is set and 0 means it isn't.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Flag Codes Value Description 1 Save as seperate zone files 2 
  Use current model view 4 Check for Material.rad files 8 Generate RIF file
  16 Include material definitions 32 Include camera views 64 Use DOS 8.3 
  filenames 128 Use ECOTECT sun angles 256 Check for #Zone.rad files 512 
  Render an Illuminance image 1024 Use ECOTECT design sky value 2048 Render
  a Daylight Factor image 4096 Generate Point Data for analysis 32768 Do 
  not display images when complete</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_flag"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_flag</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">flag</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.set_flag">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets or resets the specified radiance option flag(s).</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>flag An integer value specifying the flag to modify according to the 
  following Radiance Flag Codes table. To modify multiple flags at once, 
  simply add their values together.</p>
  <p>[state] This optional parameter specifies whether or not to set the 
  specified flag. This is a boolean value where 1 or true represents the 
  affirmative and 0 or false the negative. If not specified, this defaults 
  to true.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Flag Codes V alue Description 1 Save as seperate zone files 2
  Use current model view 4 Check for Material.rad files 8 Generate RIF file
  16 Include material definitions 32 Include camera views 64 Use DOS 8.3 
  filenames 128 Use ECOTECT sun angles 256 Check for #Zone.rad files 512 
  Render an Illuminance image 1024 Use ECOTECT design sky value 2048 Render
  a Daylight Factor image 4096 Generate Point Data for analysis 32768 Do 
  not display images when complete</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_resolution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_resolution</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.get_resolution">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current setting specifying the resolution of the 
  resulting image.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>xres The resulting image width in pixels.</p>
  <p>yres The resulting image height in pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_resolution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_resolution</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">xres</span>,
        <span class="sig-arg">yres</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.radiance-pysrc.html#Radiance.set_resolution">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the resolution for the resulting image. Results may vary 
  depending on the CAMERA view aspect ratio. Basically, one dimension will 
  always be accurate but the other will be modified to maintain the CAMERA 
  aspect ratio.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>xres The resulting image width in pixels.</p>
  <p>yres The resulting image height in pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="action"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">action</h3>
  <p>Retrieves the current set radiance render action setting.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result An integer value corresponding to the following Radiance 
  Actions table.</p>
  <p>Relevant Data Table(s) Radiance Actions Value Description 0 Save Only 
  1 Run RadTool 2 Interactive Render 3 Final Render (Default)</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current set radiance render action setting.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">action</span>=<span class="summary-sig-default">3</span>)</span>
        - Sets the radiance render action setting.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="detail"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">detail</h3>
  <p>Retrieves the current level of geometric complexity within the 
  model.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>detail An integer value corresponding to the following Radiance 
  Settings table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Settings Token Value Description low 0 Low medium 1 Medium 
  high 2 High</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current level of geometric complexity within the model.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">detail</span>)</span>
        - Sets the current level of geometric complexity within the model.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="image_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">image_type</h3>
  <p>Retrieves the currently set image type.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>image An integer value corresponding to the Radiance Image Types table
  below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Image Types Value Description 0 Luminance (cd/m^2) 1 
  Illuminance (Lux) 2 Daylight Factor (%) 3 Sky Component (%)</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the currently set image type.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the image type that is to be generated.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="lights"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">lights</h3>
  <p>Retrieves the current setting for how LIGHT objects are exported in 
  Radiance scene files.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>lights An integer value corresponding to the Radiance Light Export 
  table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Light Export Value Description 0 Turn LIGHTS Off 1 Generate 
  Automatically 2 Generate as Spheres 3 Generate as Markers</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting for how LIGHT objects are exported in 
Radiance scene files.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">lights</span>)</span>
        - Sets the option for how LIGHT objects are exported in Radiance scene files.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="point_data"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">point_data</h3>
  <p>Retrieves the current setting for what, if any, point data is exported
  for analysis in Radiance.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value corresponding to values in the following 
  Radiance Point Data table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Point Data Value Description -1 No point data generated 0 
  Current 2D analysis grid 1 Current 3D analysis grid 2 Objects tagged as 
  shaded 3 Currently selected objects</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting for what, if any, point data is exported for 
analysis in Radiance.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the current setting for what, if any, point data is exported for 
analysis in Radiance.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="quality"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">quality</h3>
  <p>Retrieves the current setting for the amount of anti-aliasing in the 
  final render.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>quality An integer value corresponding to the following Radiance 
  Settings table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Settings Token Value Description low 0 Low medium 1 Medium 
  high 2 High</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting for the amount of anti-aliasing in the final 
render.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">quality</span>)</span>
        - Sets the amount of anti-aliasing in the final render.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="reflections"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">reflections</h3>
  <p>Retrieves the current setting for the number of surface reflections 
  that are traced from each sampling point ray.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>bounces The number of bounces given as an integer value between 0 and 
  12.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting for the number of surface reflections that 
are traced from each sampling point ray.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">bounces</span>)</span>
        - Sets the number of surface reflections that are traced from each sampling 
point ray.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">scale</h3>
  <p>Retrieves the current setting of the scaling value from world 
  coordinates to Radiance coordinantes.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>scale A decimal value containing the scaling value.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting of the scaling value from world coordinates 
to Radiance coordinantes.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">scale</span>)</span>
        - Sets the scaling value from world to Radiance coordinantes.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="sky"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">sky</h3>
  <p>Retrieves the current setting of how the sky is exported in the 
  sky.rad file.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>skytype An integer value corresponding to values in the following 
  Radiance Sky Types table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Radiance Sky Types Value Description 0 [No Sky] 1 Sunny with sun 2 
  Sunny without sun 3 Intermediate with sun 4 Intermediate no sun 5 
  Overcast sky 6 Uniform sky</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the current setting of how the sky is exported in the sky.rad 
file.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">sky_type</span>)</span>
        - Sets how the sky is exported in the sky.rad file.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="variability"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">variability</h3>
  <p>Retrieves the setting of the likely difference in light levels between
  adjacent points on a surface.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>variability An integer value corresponding to the following Radiance 
  Settings table.</p>
  <p>Relevant Data Table(s) Radiance Settings Token Value Description low 0
  Low medium 1 Medium high 2 High</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the setting of the likely difference in light levels between 
adjacent points on a surface.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">variability</span>)</span>
        - Sets the likely difference in light levels between adjacent points on a 
surface.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="view_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">view_type</h3>
  <p>Retrieves the currently set internal/external view type. If external, 
  RADIANCE adds an ambient component to the scene to simulate outside 
  conditions so you should be careful to ensure this setting is 
  correct.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value corresponding to the Radiance View Types table 
  below.</p>
  <p>Relevant Data Table(s) Radiance View Types Value Description 0 
  Interior View 1 Exterior view</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the currently set internal/external view type.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span>
        - Sets the internal/external view type that is to be generated.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
